home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / include / linux / pnp.h < prev    next >
C/C++ Source or Header  |  2005-10-13  |  17KB  |  457 lines
  1. /*
  2.  * Linux Plug and Play Support
  3.  * Copyright by Adam Belay <ambx1@neo.rr.com>
  4.  *
  5.  */
  6.  
  7. #ifndef _LINUX_PNP_H
  8. #define _LINUX_PNP_H
  9.  
  10. #ifdef __KERNEL__
  11.  
  12. #include <linux/device.h>
  13. #include <linux/list.h>
  14. #include <linux/errno.h>
  15. #include <linux/mod_devicetable.h>
  16.  
  17. #define PNP_MAX_PORT        8
  18. #define PNP_MAX_MEM        4
  19. #define PNP_MAX_IRQ        2
  20. #define PNP_MAX_DMA        2
  21. #define PNP_NAME_LEN        50
  22.  
  23. struct pnp_protocol;
  24. struct pnp_dev;
  25.  
  26.  
  27. /*
  28.  * Resource Management
  29.  */
  30.  
  31. /* Use these instead of directly reading pnp_dev to get resource information */
  32. #define pnp_port_start(dev,bar)   ((dev)->res.port_resource[(bar)].start)
  33. #define pnp_port_end(dev,bar)     ((dev)->res.port_resource[(bar)].end)
  34. #define pnp_port_flags(dev,bar)   ((dev)->res.port_resource[(bar)].flags)
  35. #define pnp_port_valid(dev,bar) \
  36.     ((pnp_port_flags((dev),(bar)) & (IORESOURCE_IO | IORESOURCE_UNSET)) \
  37.         == IORESOURCE_IO)
  38. #define pnp_port_len(dev,bar) \
  39.     ((pnp_port_start((dev),(bar)) == 0 &&    \
  40.       pnp_port_end((dev),(bar)) ==        \
  41.       pnp_port_start((dev),(bar))) ? 0 :    \
  42.                           \
  43.      (pnp_port_end((dev),(bar)) -        \
  44.       pnp_port_start((dev),(bar)) + 1))
  45.  
  46. #define pnp_mem_start(dev,bar)   ((dev)->res.mem_resource[(bar)].start)
  47. #define pnp_mem_end(dev,bar)     ((dev)->res.mem_resource[(bar)].end)
  48. #define pnp_mem_flags(dev,bar)   ((dev)->res.mem_resource[(bar)].flags)
  49. #define pnp_mem_valid(dev,bar) \
  50.     ((pnp_mem_flags((dev),(bar)) & (IORESOURCE_MEM | IORESOURCE_UNSET)) \
  51.         == IORESOURCE_MEM)
  52. #define pnp_mem_len(dev,bar) \
  53.     ((pnp_mem_start((dev),(bar)) == 0 &&    \
  54.       pnp_mem_end((dev),(bar)) ==        \
  55.       pnp_mem_start((dev),(bar))) ? 0 :    \
  56.                           \
  57.      (pnp_mem_end((dev),(bar)) -        \
  58.       pnp_mem_start((dev),(bar)) + 1))
  59.  
  60. #define pnp_irq(dev,bar)     ((dev)->res.irq_resource[(bar)].start)
  61. #define pnp_irq_flags(dev,bar)     ((dev)->res.irq_resource[(bar)].flags)
  62. #define pnp_irq_valid(dev,bar) \
  63.     ((pnp_irq_flags((dev),(bar)) & (IORESOURCE_IRQ | IORESOURCE_UNSET)) \
  64.         == IORESOURCE_IRQ)
  65.  
  66. #define pnp_dma(dev,bar)     ((dev)->res.dma_resource[(bar)].start)
  67. #define pnp_dma_flags(dev,bar)     ((dev)->res.dma_resource[(bar)].flags)
  68. #define pnp_dma_valid(dev,bar) \
  69.     ((pnp_dma_flags((dev),(bar)) & (IORESOURCE_DMA | IORESOURCE_UNSET)) \
  70.         == IORESOURCE_DMA)
  71.  
  72. #define PNP_PORT_FLAG_16BITADDR    (1<<0)
  73. #define PNP_PORT_FLAG_FIXED    (1<<1)
  74.  
  75. struct pnp_port {
  76.     unsigned short min;        /* min base number */
  77.     unsigned short max;        /* max base number */
  78.     unsigned char align;        /* align boundary */
  79.     unsigned char size;        /* size of range */
  80.     unsigned char flags;        /* port flags */
  81.     unsigned char pad;        /* pad */
  82.     struct pnp_port *next;        /* next port */
  83. };
  84.  
  85. #define PNP_IRQ_NR 256
  86. struct pnp_irq {
  87.     DECLARE_BITMAP(map, PNP_IRQ_NR); /* bitmaks for IRQ lines */
  88.     unsigned char flags;        /* IRQ flags */
  89.     unsigned char pad;        /* pad */
  90.     struct pnp_irq *next;        /* next IRQ */
  91. };
  92.  
  93. struct pnp_dma {
  94.     unsigned char map;        /* bitmask for DMA channels */
  95.     unsigned char flags;        /* DMA flags */
  96.     struct pnp_dma *next;        /* next port */
  97. };
  98.  
  99. struct pnp_mem {
  100.     unsigned int min;        /* min base number */
  101.     unsigned int max;        /* max base number */
  102.     unsigned int align;        /* align boundary */
  103.     unsigned int size;        /* size of range */
  104.     unsigned char flags;        /* memory flags */
  105.     unsigned char pad;        /* pad */
  106.     struct pnp_mem *next;        /* next memory resource */
  107. };
  108.  
  109. #define PNP_RES_PRIORITY_PREFERRED    0
  110. #define PNP_RES_PRIORITY_ACCEPTABLE    1
  111. #define PNP_RES_PRIORITY_FUNCTIONAL    2
  112. #define PNP_RES_PRIORITY_INVALID    65535
  113.  
  114. struct pnp_option {
  115.     unsigned short priority;    /* priority */
  116.     struct pnp_port *port;        /* first port */
  117.     struct pnp_irq *irq;        /* first IRQ */
  118.     struct pnp_dma *dma;        /* first DMA */
  119.     struct pnp_mem *mem;        /* first memory resource */
  120.     struct pnp_option *next;    /* used to chain dependent resources */
  121. };
  122.  
  123. struct pnp_resource_table {
  124.     struct resource port_resource[PNP_MAX_PORT];
  125.     struct resource mem_resource[PNP_MAX_MEM];
  126.     struct resource dma_resource[PNP_MAX_DMA];
  127.     struct resource irq_resource[PNP_MAX_IRQ];
  128. };
  129.  
  130.  
  131. /*
  132.  * Device Managemnt
  133.  */
  134.  
  135. struct pnp_card {
  136.     struct device dev;        /* Driver Model device interface */
  137.     unsigned char number;        /* used as an index, must be unique */
  138.     struct list_head global_list;    /* node in global list of cards */
  139.     struct list_head protocol_list;    /* node in protocol's list of cards */
  140.     struct list_head devices;    /* devices attached to the card */
  141.  
  142.     struct pnp_protocol * protocol;
  143.     struct pnp_id * id;        /* contains supported EISA IDs*/
  144.  
  145.     char name[PNP_NAME_LEN];    /* contains a human-readable name */
  146.     unsigned char    pnpver;        /* Plug & Play version */
  147.     unsigned char    productver;    /* product version */
  148.     unsigned int    serial;        /* serial number */
  149.     unsigned char    checksum;    /* if zero - checksum passed */
  150.     struct proc_dir_entry *procdir;    /* directory entry in /proc/bus/isapnp */
  151. };
  152.  
  153. #define global_to_pnp_card(n) list_entry(n, struct pnp_card, global_list)
  154. #define protocol_to_pnp_card(n) list_entry(n, struct pnp_card, protocol_list)
  155. #define to_pnp_card(n) container_of(n, struct pnp_card, dev)
  156. #define pnp_for_each_card(card) \
  157.     for((card) = global_to_pnp_card(pnp_cards.next); \
  158.     (card) != global_to_pnp_card(&pnp_cards); \
  159.     (card) = global_to_pnp_card((card)->global_list.next))
  160.  
  161. struct pnp_card_link {
  162.     struct pnp_card * card;
  163.     struct pnp_card_driver * driver;
  164.     void * driver_data;
  165. };
  166.  
  167. static inline void *pnp_get_card_drvdata (struct pnp_card_link *pcard)
  168. {
  169.     return pcard->driver_data;
  170. }
  171.  
  172. static inline void pnp_set_card_drvdata (struct pnp_card_link *pcard, void *data)
  173. {
  174.     pcard->driver_data = data;
  175. }
  176.  
  177. struct pnp_dev {
  178.     struct device dev;        /* Driver Model device interface */
  179.     unsigned char number;        /* used as an index, must be unique */
  180.     int status;
  181.  
  182.     struct list_head global_list;    /* node in global list of devices */
  183.     struct list_head protocol_list;    /* node in list of device's protocol */
  184.     struct list_head card_list;    /* node in card's list of devices */
  185.     struct list_head rdev_list;    /* node in cards list of requested devices */
  186.  
  187.     struct pnp_protocol * protocol;
  188.     struct pnp_card * card;        /* card the device is attached to, none if NULL */
  189.     struct pnp_driver * driver;
  190.     struct pnp_card_link * card_link;
  191.  
  192.     struct pnp_id    * id;    /* supported EISA IDs*/
  193.  
  194.     int active;
  195.     int capabilities;
  196.     struct pnp_option * independent;
  197.     struct pnp_option * dependent;
  198.     struct pnp_resource_table res;
  199.  
  200.     char name[PNP_NAME_LEN];    /* contains a human-readable name */
  201.     unsigned short    regs;        /* ISAPnP: supported registers */
  202.     int         flags;        /* used by protocols */
  203.     struct proc_dir_entry *procent;    /* device entry in /proc/bus/isapnp */
  204.     void *data;
  205. };
  206.  
  207. #define global_to_pnp_dev(n) list_entry(n, struct pnp_dev, global_list)
  208. #define card_to_pnp_dev(n) list_entry(n, struct pnp_dev, card_list)
  209. #define protocol_to_pnp_dev(n) list_entry(n, struct pnp_dev, protocol_list)
  210. #define    to_pnp_dev(n) container_of(n, struct pnp_dev, dev)
  211. #define pnp_for_each_dev(dev) \
  212.     for((dev) = global_to_pnp_dev(pnp_global.next); \
  213.     (dev) != global_to_pnp_dev(&pnp_global); \
  214.     (dev) = global_to_pnp_dev((dev)->global_list.next))
  215. #define card_for_each_dev(card,dev) \
  216.     for((dev) = card_to_pnp_dev((card)->devices.next); \
  217.     (dev) != card_to_pnp_dev(&(card)->devices); \
  218.     (dev) = card_to_pnp_dev((dev)->card_list.next))
  219. #define pnp_dev_name(dev) (dev)->name
  220.  
  221. static inline void *pnp_get_drvdata (struct pnp_dev *pdev)
  222. {
  223.     return dev_get_drvdata(&pdev->dev);
  224. }
  225.  
  226. static inline void pnp_set_drvdata (struct pnp_dev *pdev, void *data)
  227. {
  228.     dev_set_drvdata(&pdev->dev, data);
  229. }
  230.  
  231. struct pnp_fixup {
  232.     char id[7];
  233.     void (*quirk_function)(struct pnp_dev *dev);    /* fixup function */
  234. };
  235.  
  236. /* config parameters */
  237. #define PNP_CONFIG_NORMAL    0x0001
  238. #define PNP_CONFIG_FORCE    0x0002    /* disables validity checking */
  239.  
  240. /* capabilities */
  241. #define PNP_READ        0x0001
  242. #define PNP_WRITE        0x0002
  243. #define PNP_DISABLE        0x0004
  244. #define PNP_CONFIGURABLE    0x0008
  245. #define PNP_REMOVABLE        0x0010
  246.  
  247. #define pnp_can_read(dev)    (((dev)->protocol) && ((dev)->protocol->get) && \
  248.                  ((dev)->capabilities & PNP_READ))
  249. #define pnp_can_write(dev)    (((dev)->protocol) && ((dev)->protocol->set) && \
  250.                  ((dev)->capabilities & PNP_WRITE))
  251. #define pnp_can_disable(dev)    (((dev)->protocol) && ((dev)->protocol->disable) && \
  252.                  ((dev)->capabilities & PNP_DISABLE))
  253. #define pnp_can_configure(dev)    ((!(dev)->active) && \
  254.                  ((dev)->capabilities & PNP_CONFIGURABLE))
  255.  
  256. #ifdef CONFIG_ISAPNP
  257. extern struct pnp_protocol isapnp_protocol;
  258. #define pnp_device_is_isapnp(dev) ((dev)->protocol == (&isapnp_protocol))
  259. #else
  260. #define pnp_device_is_isapnp(dev) 0
  261. #endif
  262.  
  263. #ifdef CONFIG_PNPBIOS
  264. extern struct pnp_protocol pnpbios_protocol;
  265. #define pnp_device_is_pnpbios(dev) ((dev)->protocol == (&pnpbios_protocol))
  266. #else
  267. #define pnp_device_is_pnpbios(dev) 0
  268. #endif
  269.  
  270.  
  271. /* status */
  272. #define PNP_READY        0x0000
  273. #define PNP_ATTACHED        0x0001
  274. #define PNP_BUSY        0x0002
  275. #define PNP_FAULTY        0x0004
  276.  
  277. /* isapnp specific macros */
  278.  
  279. #define isapnp_card_number(dev)    ((dev)->card ? (dev)->card->number : -1)
  280. #define isapnp_csn_number(dev)  ((dev)->number)
  281.  
  282. /*
  283.  * Driver Management
  284.  */
  285.  
  286. struct pnp_id {
  287.     char id[PNP_ID_LEN];
  288.     struct pnp_id * next;
  289. };
  290.  
  291. struct pnp_driver {
  292.     char * name;
  293.     const struct pnp_device_id *id_table;
  294.     unsigned int flags;
  295.     int  (*probe)  (struct pnp_dev *dev, const struct pnp_device_id *dev_id);
  296.     void (*remove) (struct pnp_dev *dev);
  297.     struct device_driver driver;
  298. };
  299.  
  300. #define    to_pnp_driver(drv) container_of(drv, struct pnp_driver, driver)
  301.  
  302. struct pnp_card_driver {
  303.     struct list_head global_list;
  304.     char * name;
  305.     const struct pnp_card_device_id *id_table;
  306.     unsigned int flags;
  307.     int  (*probe)  (struct pnp_card_link *card, const struct pnp_card_device_id *card_id);
  308.     void (*remove) (struct pnp_card_link *card);
  309.     struct pnp_driver link;
  310. };
  311.  
  312. #define    to_pnp_card_driver(drv) container_of(drv, struct pnp_card_driver, link)
  313.  
  314. /* pnp driver flags */
  315. #define PNP_DRIVER_RES_DO_NOT_CHANGE    0x0001    /* do not change the state of the device */
  316. #define PNP_DRIVER_RES_DISABLE        0x0003    /* ensure the device is disabled */
  317.  
  318.  
  319. /*
  320.  * Protocol Management
  321.  */
  322.  
  323. struct pnp_protocol {
  324.     struct list_head    protocol_list;
  325.     char              * name;
  326.  
  327.     /* resource control functions */
  328.     int (*get)(struct pnp_dev *dev, struct pnp_resource_table *res);
  329.     int (*set)(struct pnp_dev *dev, struct pnp_resource_table *res);
  330.     int (*disable)(struct pnp_dev *dev);
  331.  
  332.     /* used by pnp layer only (look but don't touch) */
  333.     unsigned char        number;        /* protocol number*/
  334.     struct device        dev;        /* link to driver model */
  335.     struct list_head    cards;
  336.     struct list_head    devices;
  337. };
  338.  
  339. #define to_pnp_protocol(n) list_entry(n, struct pnp_protocol, protocol_list)
  340. #define protocol_for_each_card(protocol,card) \
  341.     for((card) = protocol_to_pnp_card((protocol)->cards.next); \
  342.     (card) != protocol_to_pnp_card(&(protocol)->cards); \
  343.     (card) = protocol_to_pnp_card((card)->protocol_list.next))
  344. #define protocol_for_each_dev(protocol,dev) \
  345.     for((dev) = protocol_to_pnp_dev((protocol)->devices.next); \
  346.     (dev) != protocol_to_pnp_dev(&(protocol)->devices); \
  347.     (dev) = protocol_to_pnp_dev((dev)->protocol_list.next))
  348.  
  349.  
  350. #if defined(CONFIG_PNP)
  351.  
  352. /* device management */
  353. int pnp_register_protocol(struct pnp_protocol *protocol);
  354. void pnp_unregister_protocol(struct pnp_protocol *protocol);
  355. int pnp_add_device(struct pnp_dev *dev);
  356. void pnp_remove_device(struct pnp_dev *dev);
  357. int pnp_device_attach(struct pnp_dev *pnp_dev);
  358. void pnp_device_detach(struct pnp_dev *pnp_dev);
  359. extern struct list_head pnp_global;
  360.  
  361. /* multidevice card support */
  362. int pnp_add_card(struct pnp_card *card);
  363. void pnp_remove_card(struct pnp_card *card);
  364. int pnp_add_card_device(struct pnp_card *card, struct pnp_dev *dev);
  365. void pnp_remove_card_device(struct pnp_dev *dev);
  366. int pnp_add_card_id(struct pnp_id *id, struct pnp_card *card);
  367. struct pnp_dev * pnp_request_card_device(struct pnp_card_link *clink, const char * id, struct pnp_dev * from);
  368. void pnp_release_card_device(struct pnp_dev * dev);
  369. int pnp_register_card_driver(struct pnp_card_driver * drv);
  370. void pnp_unregister_card_driver(struct pnp_card_driver * drv);
  371. extern struct list_head pnp_cards;
  372.  
  373. /* resource management */
  374. struct pnp_option * pnp_register_independent_option(struct pnp_dev *dev);
  375. struct pnp_option * pnp_register_dependent_option(struct pnp_dev *dev, int priority);
  376. int pnp_register_irq_resource(struct pnp_option *option, struct pnp_irq *data);
  377. int pnp_register_dma_resource(struct pnp_option *option, struct pnp_dma *data);
  378. int pnp_register_port_resource(struct pnp_option *option, struct pnp_port *data);
  379. int pnp_register_mem_resource(struct pnp_option *option, struct pnp_mem *data);
  380. void pnp_init_resource_table(struct pnp_resource_table *table);
  381. int pnp_assign_resources(struct pnp_dev *dev, int depnum);
  382. int pnp_manual_config_dev(struct pnp_dev *dev, struct pnp_resource_table *res, int mode);
  383. int pnp_auto_config_dev(struct pnp_dev *dev);
  384. int pnp_validate_config(struct pnp_dev *dev);
  385. int pnp_activate_dev(struct pnp_dev *dev);
  386. int pnp_disable_dev(struct pnp_dev *dev);
  387. void pnp_resource_change(struct resource *resource, unsigned long start, unsigned long size);
  388.  
  389. /* protocol helpers */
  390. int pnp_is_active(struct pnp_dev * dev);
  391. int compare_pnp_id(struct pnp_id * pos, const char * id);
  392. int pnp_add_id(struct pnp_id *id, struct pnp_dev *dev);
  393. int pnp_register_driver(struct pnp_driver *drv);
  394. void pnp_unregister_driver(struct pnp_driver *drv);
  395.  
  396. #else
  397.  
  398. /* device management */
  399. static inline int pnp_register_protocol(struct pnp_protocol *protocol) { return -ENODEV; }
  400. static inline void pnp_unregister_protocol(struct pnp_protocol *protocol) { }
  401. static inline int pnp_init_device(struct pnp_dev *dev) { return -ENODEV; }
  402. static inline int pnp_add_device(struct pnp_dev *dev) { return -ENODEV; }
  403. static inline void pnp_remove_device(struct pnp_dev *dev) { }
  404. static inline int pnp_device_attach(struct pnp_dev *pnp_dev) { return -ENODEV; }
  405. static inline void pnp_device_detach(struct pnp_dev *pnp_dev) { ; }
  406.  
  407. /* multidevice card support */
  408. static inline int pnp_add_card(struct pnp_card *card) { return -ENODEV; }
  409. static inline void pnp_remove_card(struct pnp_card *card) { ; }
  410. static inline int pnp_add_card_device(struct pnp_card *card, struct pnp_dev *dev) { return -ENODEV; }
  411. static inline void pnp_remove_card_device(struct pnp_dev *dev) { ; }
  412. static inline int pnp_add_card_id(struct pnp_id *id, struct pnp_card *card) { return -ENODEV; }
  413. static inline struct pnp_dev * pnp_request_card_device(struct pnp_card_link *clink, const char * id, struct pnp_dev * from) { return NULL; }
  414. static inline void pnp_release_card_device(struct pnp_dev * dev) { ; }
  415. static inline int pnp_register_card_driver(struct pnp_card_driver * drv) { return -ENODEV; }
  416. static inline void pnp_unregister_card_driver(struct pnp_card_driver * drv) { ; }
  417.  
  418. /* resource management */
  419. static inline struct pnp_option * pnp_register_independent_option(struct pnp_dev *dev) { return NULL; }
  420. static inline struct pnp_option * pnp_register_dependent_option(struct pnp_dev *dev, int priority) { return NULL; }
  421. static inline int pnp_register_irq_resource(struct pnp_option *option, struct pnp_irq *data) { return -ENODEV; }
  422. static inline int pnp_register_dma_resource(struct pnp_option *option, struct pnp_dma *data) { return -ENODEV; }
  423. static inline int pnp_register_port_resource(struct pnp_option *option, struct pnp_port *data) { return -ENODEV; }
  424. static inline int pnp_register_mem_resource(struct pnp_option *option, struct pnp_mem *data) { return -ENODEV; }
  425. static inline void pnp_init_resource_table(struct pnp_resource_table *table) { }
  426. static inline int pnp_assign_resources(struct pnp_dev *dev, int depnum) { return -ENODEV; }
  427. static inline int pnp_manual_config_dev(struct pnp_dev *dev, struct pnp_resource_table *res, int mode) { return -ENODEV; }
  428. static inline int pnp_auto_config_dev(struct pnp_dev *dev) { return -ENODEV; }
  429. static inline int pnp_validate_config(struct pnp_dev *dev) { return -ENODEV; }
  430. static inline int pnp_activate_dev(struct pnp_dev *dev) { return -ENODEV; }
  431. static inline int pnp_disable_dev(struct pnp_dev *dev) { return -ENODEV; }
  432. static inline void pnp_resource_change(struct resource *resource, unsigned long start, unsigned long size) { }
  433.  
  434. /* protocol helpers */
  435. static inline int pnp_is_active(struct pnp_dev * dev) { return 0; }
  436. static inline int compare_pnp_id(struct pnp_id * pos, const char * id) { return -ENODEV; }
  437. static inline int pnp_add_id(struct pnp_id *id, struct pnp_dev *dev) { return -ENODEV; }
  438. static inline int pnp_register_driver(struct pnp_driver *drv) { return -ENODEV; }
  439. static inline void pnp_unregister_driver(struct pnp_driver *drv) { ; }
  440.  
  441. #endif /* CONFIG_PNP */
  442.  
  443.  
  444. #define pnp_err(format, arg...) printk(KERN_ERR "pnp: " format "\n" , ## arg)
  445. #define pnp_info(format, arg...) printk(KERN_INFO "pnp: " format "\n" , ## arg)
  446. #define pnp_warn(format, arg...) printk(KERN_WARNING "pnp: " format "\n" , ## arg)
  447.  
  448. #ifdef DEBUG
  449. #define pnp_dbg(format, arg...) printk(KERN_DEBUG "pnp: " format "\n" , ## arg)
  450. #else
  451. #define pnp_dbg(format, arg...) do {} while (0)
  452. #endif
  453.  
  454. #endif /* __KERNEL__ */
  455.  
  456. #endif /* _LINUX_PNP_H */
  457.